Noise for Kotlin/nl.sanderdijkhuis.noise.cryptography

Package-level declarations

Provides means to implement and apply cryptographic function dependencies.

The module depends on the following cryptographic functions:

ChaCha20-Poly1305 Authenticated Encryption with Associated Data (AEAD) from RFC 8439
SHA-256 hashing from FIPS 180-4
X25519 Diffie-Hellman exchange from RFC 7748

These can be implemented using for example Java SE 11 or Bouncy Castle.

Note that in some cases we speak of “no-op encryption”. This is to meet the EncryptWithAd and DecryptWithAd Noise specification which provide the identity function when no cipher key is set.

Types

value class AssociatedData(val data: Data)

For use in Authenticated Encryption with Associated Data.

value class CipherKey(val data: Data)

value class Ciphertext(val data: Data)

Result of Authenticated Encryption with Associated Data, or of no-op encryption.

interface Cryptography

Provide the specified algorithm implementations.

value class Digest(val data: Data)

Outcome of the hashing function.

value class Nonce(val value: ULong)

An incrementing but non-wrapping number to be used once for encryption.

value class Plaintext(val data: Data)

value class PrivateKey(val value: ByteArray)

value class PublicKey(val data: Data)

value class SharedSecret(val data: Data)

Outcome of Diffie-Hellman key agreement.